What is arr-flatten?
The arr-flatten npm package is a utility for flattening nested arrays into a single-level array. It is a simple and focused package that does not handle arguments other than arrays (e.g., it does not flatten array-like objects).
What are arr-flatten's main functionalities?
Flatten nested arrays
This feature allows you to flatten a deeply nested array into a single-level array. The code sample demonstrates how to use the `.flat()` method to flatten an array with multiple levels of nesting.
[1, [2, [3, [4]], 5]].flat()
Other packages similar to arr-flatten
lodash.flatten
Lodash provides a method called `flatten` that can flatten arrays up to one level deep. It is part of the larger Lodash library, which offers a wide range of utilities for working with arrays, objects, and other types. Compared to arr-flatten, lodash.flatten is part of a larger utility library and may not be as lightweight if you only need to flatten arrays.
flat
The `flat` package offers functionality to flatten arrays with additional options, such as specifying the depth to which the array should be flattened. It can also flatten array-like objects, unlike arr-flatten. This package provides more flexibility and features compared to arr-flatten, which is more minimalistic.
arr-flatten
Recursively flatten an array or arrays. This is the fastest implementation of array flatten.
Why another flatten utility? Because this one is faster.
Run benchmarks
node benchmark
Run tests
npm test
Install
Install with npm
npm i arr-flatten --save
Install with bower
bower install arr-flatten --save
Usage
var flatten = require('arr-flatten');
flatten(['a', ['b', ['c']], 'd', ['e']]);
Author
Jon Schlinkert
License
Copyright (c) 2014 Jon Schlinkert, contributors.
Released under the MIT license
This file was generated by verb-cli on November 09, 2014.